Create Slotting Rule

cURL

curl --request POST \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}'

import json
import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count"
headers = {"Authorization": "Bearer <token>"}
payload = json.loads('{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}')

response = requests.request('POST', url, headers=headers, json=payload)
print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}),
};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count',
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer <token>', 'Content-Type: application/json'],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    request, _ := http.NewRequest("POST", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count", strings.NewReader(`{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}`))
    request.Header.Add("Authorization", "Bearer <token>")
    request.Header.Add("Content-Type", "application/json")
    response, _ := http.DefaultClient.Do(request)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\"name\":\"Regulated aerosols require Hazmat storage\",\"relation\":\"require\",\"merchant_ids\":[2,7],\"product_profile_ids\":[12],\"product_profile_match_mode\":\"any\",\"handling_class_ids\":[4],\"location_profile_id\":26}")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count')
request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "resource": {
    "type": "SlottingRule",
    "id": 42,
    "rule_set": {
      "type": "SlottingRuleSet",
      "id": 19
    },
    "name": "Regulated aerosols require Hazmat storage",
    "relation": "require",
    "strength": null,
    "priority": 75,
    "merchant_ids": [
      2,
      7
    ],
    "product_profile_ids": [
      12
    ],
    "product_profile_match_mode": "any",
    "handling_class_ids": [
      4
    ],
    "merchants": [
      {
        "type": "Merchant",
        "id": 2
      },
      {
        "type": "Merchant",
        "id": 7
      }
    ],
    "product_profiles": [
      {
        "type": "ProductProfile",
        "id": 12
      }
    ],
    "handling_classes": [
      {
        "type": "HandlingClass",
        "id": 4
      }
    ],
    "location_profile": {
      "type": "LocationProfile",
      "id": 26
    },
    "subject_readable": "Merchants: Retail Direct, Marketplace; Product Profile: Regulated Aerosols; Handling Class: Hazmat",
    "location_match_readable": "zone_id in [4] && is_pickable",
    "has_conflicts": false,
    "conflict_detail": null,
    "created_at": "2026-08-10T10:45:00Z",
    "updated_at": "2026-08-10T10:45:00Z"
  },
  "included": {
    "SlottingRuleSet": [
      {
        "type": "SlottingRuleSet",
        "id": 19,
        "name": "Regulated Goods Storage",
        "is_active": true
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 26,
        "name": "Cold Storage Pick Faces",
        "status": "ready",
        "member_count": 486
      }
    ]
  },
  "meta": {
    "processing_time": 0.012
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

POST

inventory

warehouses

{id}

slotting-rule-sets

{rule_set_id}

rules

cURL

curl --request POST \
  --url 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}'

import json
import requests

url = "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count"
headers = {"Authorization": "Bearer <token>"}
payload = json.loads('{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}')

response = requests.request('POST', url, headers=headers, json=payload)
print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}),
};

fetch('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count', options)
  .then(response => response.json())
  .then(response => console.log(response));

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count',
    CURLOPT_RETURNTRANSFER => TRUE,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}',
    CURLOPT_HTTPHEADER => ['Authorization: Bearer <token>', 'Content-Type: application/json'],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    request, _ := http.NewRequest("POST", "https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count", strings.NewReader(`{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}`))
    request.Header.Add("Authorization", "Bearer <token>")
    request.Header.Add("Content-Type", "application/json")
    response, _ := http.DefaultClient.Do(request)
    defer response.Body.Close()
    body, _ := io.ReadAll(response.Body)
    fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.post("https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\"name\":\"Regulated aerosols require Hazmat storage\",\"relation\":\"require\",\"merchant_ids\":[2,7],\"product_profile_ids\":[12],\"product_profile_match_mode\":\"any\",\"handling_class_ids\":[4],\"location_profile_id\":26}")
  .asString();

require 'uri'
require 'net/http'

url = URI('https://example.shipstream.app/api/global/v1/inventory/warehouses/1/slotting-rule-sets/19/rules?fields=merchants,product_profiles,handling_classes&fields:rule_set=name,is_active&fields:merchants=code,name,status&fields:product_profiles=name,code&fields:handling_classes=name,code&fields:location_profile=name,status,member_count')
request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{"name":"Regulated aerosols require Hazmat storage","relation":"require","merchant_ids":[2,7],"product_profile_ids":[12],"product_profile_match_mode":"any","handling_class_ids":[4],"location_profile_id":26}'

response = Net::HTTP.start(url.hostname, url.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.read_body

{
  "resource": {
    "type": "SlottingRule",
    "id": 42,
    "rule_set": {
      "type": "SlottingRuleSet",
      "id": 19
    },
    "name": "Regulated aerosols require Hazmat storage",
    "relation": "require",
    "strength": null,
    "priority": 75,
    "merchant_ids": [
      2,
      7
    ],
    "product_profile_ids": [
      12
    ],
    "product_profile_match_mode": "any",
    "handling_class_ids": [
      4
    ],
    "merchants": [
      {
        "type": "Merchant",
        "id": 2
      },
      {
        "type": "Merchant",
        "id": 7
      }
    ],
    "product_profiles": [
      {
        "type": "ProductProfile",
        "id": 12
      }
    ],
    "handling_classes": [
      {
        "type": "HandlingClass",
        "id": 4
      }
    ],
    "location_profile": {
      "type": "LocationProfile",
      "id": 26
    },
    "subject_readable": "Merchants: Retail Direct, Marketplace; Product Profile: Regulated Aerosols; Handling Class: Hazmat",
    "location_match_readable": "zone_id in [4] && is_pickable",
    "has_conflicts": false,
    "conflict_detail": null,
    "created_at": "2026-08-10T10:45:00Z",
    "updated_at": "2026-08-10T10:45:00Z"
  },
  "included": {
    "SlottingRuleSet": [
      {
        "type": "SlottingRuleSet",
        "id": 19,
        "name": "Regulated Goods Storage",
        "is_active": true
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 2,
        "code": "retail_direct",
        "name": "Retail Direct",
        "status": "active"
      },
      {
        "type": "Merchant",
        "id": 7,
        "code": "marketplace",
        "name": "Marketplace",
        "status": "active"
      }
    ],
    "ProductProfile": [
      {
        "type": "ProductProfile",
        "id": 12,
        "name": "Regulated Aerosols",
        "code": "regulated_aerosols"
      }
    ],
    "HandlingClass": [
      {
        "type": "HandlingClass",
        "id": 4,
        "name": "Hazmat",
        "code": "hazmat"
      }
    ],
    "LocationProfile": [
      {
        "type": "LocationProfile",
        "id": 26,
        "name": "Cold Storage Pick Faces",
        "status": "ready",
        "member_count": 486
      }
    ]
  },
  "meta": {
    "processing_time": 0.012
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

integer<int32>

required

The id of the referenced Warehouse.

rule_set_id

integer<int32>

required

The id of the owning SlottingRuleSet.

Query Parameters

fields

enum<string>[]

Specify fields of the SlottingRule object to include in the response.

Available options:

all,

rule_set,

name,

relation,

strength,

priority,

merchant_ids,

merchants,

product_profile_ids,

product_profiles,

product_profile_match_mode,

handling_class_ids,

handling_classes,

location_profile,

subject_readable,

location_match_readable,

has_conflicts,

conflict_detail,

created_at,

updated_at

fields:rule_set

enum<string>[]

Specify fields of the SlottingRuleSet object referenced by each Rule. See the selecting fields page for more information. Specify fields of the SlottingRuleSet object to include in the response.

Available options:

all,

name,

description,

is_active,

rule_count,

has_conflicts,

conflicting_rule_count,

created_at,

updated_at

fields:location_profile

enum<string>[]

Specify fields of the LocationProfile object referenced by each Rule. See the selecting fields page for more information. Specify direct display fields of an included LocationProfile object.

Available options:

name,

description,

status,

member_count,

match_readable,

created_at,

updated_at

fields:merchants

enum<string>[]

Specify direct fields of selected Merchant objects to include under included.Merchant. Add merchants to the root fields parameter to return the relationship. type and id are always returned. Specify direct fields of an included Merchant object.

Available options:

code,

name,

status,

created_at,

updated_at

fields:product_profiles

enum<string>[]

Specify fields of selected ProductProfile objects to include under included.ProductProfile. Add product_profiles to the root fields parameter to return the relationship. type and id are always returned. Specify fields of an included ProductProfile object.

Available options:

basic,

all,

name,

code,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

fields:handling_classes

enum<string>[]

Specify direct fields of selected HandlingClass objects to include under included.HandlingClass. Add handling_classes to the root fields parameter to return the relationship. type and id are always returned. Specify direct fields of an included HandlingClass object.

Available options:

name,

code,

sort_order,

conditions,

conditions_readable,

matched_count,

classification,

created_at,

updated_at

Body

application/json

The body of a Slotting Rule create request. The Warehouse and owning Rule Set come from the path. The Location Profile must belong to that Warehouse and have a ready active revision.

name

string

required

User-visible Rule name.

Required string length: 1 - 255

Example:

"Regulated aerosols require Hazmat storage"

relation

enum<string>

required

Hard requirement or advisory preference applied by the Rule.

Available options:

require,

forbid,

prefer,

discourage

Example:

"require"

location_profile_id

integer<int32>

required

Ready Location Profile in the path Warehouse targeted by the Rule.

Required range: x >= 1

Example:

26

strength

enum<string> | null

Required for prefer and discourage. Omit this property for require and forbid; explicitly sending it for a hard Rule is rejected.

Available options:

low,

normal,

high,

critical,

null

Example:

null

merchant_ids

integer<int32>[] | null

Merchant IDs selected by the Rule; null or an empty list means every Merchant.

Maximum array length: 100

Required range: x >= 1

Example:

[2, 7]

product_profile_ids

integer<int32>[]

Product Profile IDs selected by the Rule; an empty list leaves this dimension unrestricted.

Maximum array length: 100

Required range: x >= 1

Example:

[12]

product_profile_match_mode

enum<string>

default:any

How the selected Product Profiles are matched. none requires at least one ID.

Available options:

any,

all,

none

Example:

"any"

handling_class_ids

integer<int32>[]

Handling Class IDs assigned to the Warehouse; an empty list leaves this dimension unrestricted.

Maximum array length: 100

Required range: x >= 1

Example:

[4]

Response

The Slotting Rule was created.

resource

SlottingRule · object

A Rule inside one Warehouse Slotting Rule Set. It selects Products and Merchants, applies a hard or advisory relation, and targets the resolved membership of one ready Location Profile. Conflict fields are the latest durable result of asynchronous Slotting conflict detection.

Show child attributes

Example:

{
  "type": "SlottingRule",
  "id": 42,
  "rule_set": { "type": "SlottingRuleSet", "id": 19 },
  "name": "Regulated aerosols require Hazmat storage",
  "relation": "require",
  "strength": null,
  "priority": 75,
  "merchant_ids": [2, 7],
  "product_profile_ids": [12],
  "product_profile_match_mode": "any",
  "handling_class_ids": [4],
  "location_profile": { "type": "LocationProfile", "id": 26 },
  "subject_readable": "Merchants: Retail Direct, Marketplace; Product Profile: Regulated Aerosols; Handling Class: Hazmat",
  "location_match_readable": "zone_id in [4] && is_pickable",
  "has_conflicts": false,
  "conflict_detail": null,
  "created_at": "2026-08-10T10:45:00Z",
  "updated_at": "2026-08-10T10:45:00Z"
}

included

object

Direct objects included by specifying nested fields. Relationship trees below these editor selections are never expanded. See the selecting fields page.

Show child attributes

Example:

{}

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Path Parameters

Query Parameters

Body

Response